SCHED: GetResourceValuesJson
Format
SCHED / GetResourceValuesJson '<ResourceName>' '<FileName>' <ResourceAttribute>
Description
The SCHED GetResourceValuesJson Connect command returns the value report for the specified attribute (capacity, accommodation, or availability) of the resource specified by the <ResourceName> parameter in JSON format. The output will be formatted as a JSON array, even if information on only a single resource's attribute is requested. Each element in this JSON array maps to information on a single resource's specified attribute (capacity, accommodation, or availability).
GetResourceValuesJson vs. GetResourceValues
The choice of command will depend on use case.
SCHED GetResourceValuesJson provides output in a commonly used format that is easy to parse. This command is preferred if resource value information will be further processed.
SCHED GetResourceValues provides output that is difficult to parse but easy to understand. This command is preferred if no further processing is required.
Parameters
- ResourceName: The parameter is a string of text in single quotes of a comma delimited list of resource names. Resource names should note be in quotes.
- FileName: The parameter is a string of text in single quotes of the absolute path of the filename. Empty string is allowed if the command does not write out to a file name.
- Attribute: The parameter options are capacity, accommodation, or availability.
Examples
Requests a capacity value report for the SSR resource in the active schedule and saves it to the file
"ResourceCapacityReport.json" located at "C:\Outputs\" Capacity
SCHED /
GetResourceValuesJson 'SSR' 'C:\Outputs\ResourceCapacityReport.json' Capacity
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / GetResourceValuesJson |
| <ResourceName> | 'SSR' |
| <FileName> | 'C:\Outputs\ResourceCapacityReport.json' |
| <Attribute> | Capacity |
Return Message
Connect returns a message that contains the value timeline for the specified resource attribute.
The following JSON file contains sample output of the above command.
The following JSON file contains sample output of the above command, with 'Capacity' replaced by 'Accommodation'.
The following JSON file contains sample output of the above command, with 'Capacity' replaced by 'Availability'.
Group Membership
This command belongs to the following group(s):
Version
12.0
